Use Swift 6.0 docs pipeline #2966
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: Documentation checking catches more issues in Swift 6.0. Modifications: Adopt the Swift 6.0 image and fix the errors. Result: More accurate docs.
glbrntt
requested changes
Nov 6, 2024
| } | ||
|
|
||
| /// Set `option` to `value` on this `Channel`. | ||
| /// - Parameters: | ||
| /// - option: The option to set. | ||
| /// - value: The new of the option. |
There was a problem hiding this comment.
Suggested change
| /// - value: The new of the option. | |
| /// - value: The value of the option. |
| @@ -321,15 +321,15 @@ extension ByteBuffer { | |||
| /// Returns a hex dump of this `ByteBuffer` in a preferred `HexDumpFormat`. | |||
| /// | |||
| /// `hexDump` provides four formats: | |||
There was a problem hiding this comment.
apropos of nothing, "four" appears to no longer be correct here.
| @preconcurrency | ||
| @inlinable | ||
| public func unwrap<NewValue: Sendable>( | ||
| orReplace replacement: NewValue |
There was a problem hiding this comment.
I think the docs and code are clearer in terms of replacement here
| /// passed in the `orElse` parameter. | ||
| @inlinable | ||
| @preconcurrency | ||
| public func unwrap<NewValue>( | ||
| orElse callback: @escaping @Sendable () -> NewValue |
There was a problem hiding this comment.
Same here, I think callback is clearer than orElse in the docs etc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Documentation checking catches more issues in Swift 6.0.
Modifications:
Adopt the Swift 6.0 image and fix the errors.
Result:
More accurate docs.